feat(push): add final status block and structured JSON output by l2ysho · Pull Request #1199 · apify/apify-cli

l2ysho · 2026-06-15T21:56:24Z

Covers the status-mapping contract introduced by the new push status block / JSON output

Add test/local/commands/push.test.ts — 10 cases over every branch: SUCCEEDED, READY/RUNNING (fire-and-forget → exit 0), ABORTED/ABORTING, TIMED_OUT/TIMING_OUT,
FAILED, and the unknown-status fallthrough. Plus an assertion that errorMessage is present on failures and absent on success/running.

Rework the end of `apify push` so agents can distinguish source-upload success from final cloud-build success (#1136). - `apify push` prints a final result block (result, upload, build, IDs, URLs, exit code, and a failure reason log tail). - `apify push --json` returns a structured result object with `ok`, `operation`, `actor`, `build`, optional `error`, and `exitCode`. - Failed, timed-out, and aborted builds return non-zero exit codes; `ok` mirrors command success. Closes #1136 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

…son-output-for-agents2

DaveHanns · 2026-06-22T13:10:34Z

+// How many trailing log lines to surface as the failure reason.
+const BUILD_LOG_TAIL_LINES = 10;
+
+interface PushResult {


Nit: prefer type over interface.

See https://www.notion.so/apify/Apify-Coding-Standards-Guide-264f39950a2280588be3f2268b9cb609?source=copy_link#264f39950a2280898b98c84f9342d686

for some reason we use 'typescript/consistent-type-definitions': ['error', 'interface'], (even before oxlint migration). We use @apify/oxlint-config but there is few additional changes in it, I guess lets align this with Apify Coding Standards in separate PR (too much noise to change all interfaces to types here).

@vladfrangu do you have some context about this type/interface decision ?

DaveHanns · 2026-06-23T07:31:25Z

+	build: { id: string; number: string; status: string; url: string };
+	error?: { phase: 'build'; message: string; logTail: string[] };
+	exitCode: number;
+}


Nit: to avoid type-checking for optional error, we could leverage discriminated union here:

type PushResultBase = { operation: 'push'; actor: { id: string; url: string }; build: { id: string; number: string; status: string; url: string }; exitCode: number; }; type PushSuccess = PushResultBase & { ok: true; }; type PushFailure = PushResultBase & { ok: false; error: { phase: 'build'; message: string; logTail: string[] }; }; type PushResult = PushSuccess | PushFailure;

see #1199 (comment)

DaveHanns · 2026-06-23T07:39:11Z

+		case ACTOR_JOB_STATUSES.READY:
+		case ACTOR_JOB_STATUSES.RUNNING:
+			return { resultLabel: 'RUNNING', exitCode: 0, ok: true };


Q: might be a bit misleading. Why don't we have resultLabel: 'READY'?

As I thinking about this now, maybe it would be better to READY and RUNNING status resolve to IN_PROGRESS result label? as READY + ok: true feels like DONE at first glance but actually it is waiting to be processed by worker

DaveHanns · 2026-06-23T07:42:00Z

+	exitCode: number;
+	ok: boolean;
+	errorMessage?: string;
+} {


Nit: the return type would deserve to be extracted into its own type.

DaveHanns · 2026-06-23T07:42:05Z

+				exitCode: CommandExitCodes.BuildTimedOut,
+				ok: false,
+				errorMessage: 'Build timed out',
+			};


Q: similarly as above, why don't we have distinguished resultLabel + errorMessage for both ABORTED and ABORTING (respectively TIMED_OUT and TIMING_OUT)?

DaveHanns · 2026-06-23T07:45:07Z

+			return { resultLabel: 'SUCCEEDED', exitCode: 0, ok: true };
+		case ACTOR_JOB_STATUSES.READY:
+		case ACTOR_JOB_STATUSES.RUNNING:
+			return { resultLabel: 'RUNNING', exitCode: 0, ok: true };


Nit: maybe the exitCode should be optional and not returned in case the process hasn't ended yet. Technically, at a time of READY and RUNNING, there is no exitCode yet. ok is alright, as at that time the process is truly ok.

DaveHanns · 2026-06-23T07:47:34Z

+				errorMessage: 'Build timed out',
+			};
+		default:
+			return { resultLabel: 'FAILED', exitCode: CommandExitCodes.BuildFailed, ok: false, errorMessage: 'Build failed' };


Nit: not super sure about the default. If there is ever a new state, it might fall back to FAILED even if it is not.

DaveHanns · 2026-06-23T07:55:44Z

+		const buildStatus = build.status as string;
+		const outcome = resolvePushOutcome(buildStatus);
+
+		const actorUrl = `https://console.apify.com${redirectUrlPart}/actors/${build.actId}`;


Nit: it is alright now, but I noticed we are hardcoding apify domain (api, console, ...) a lot in the cli. At some point we should develop a registry of domains so that we have a single source of truth.

Ignore as it is out of scope of this PR.

…son-output-for-agents2

DaveHanns · 2026-06-23T08:10:21Z

-		} else {
-			error({ message: 'Build failed!' });
-			process.exitCode = CommandExitCodes.BuildFailed;
+		const lines = [


Q: do we already implement same style logging in case the upload itself fails?

DaveHanns

Few nits and suggestions. Otherwise looks good.

l2ysho self-assigned this Jun 15, 2026

github-actions Bot added this to the 143rd sprint - Tooling team milestone Jun 15, 2026

github-actions Bot added the t-tooling Issues with this label are in the ownership of the tooling team. label Jun 15, 2026

l2ysho added t-dx Issues owned by the DX team. and removed t-tooling Issues with this label are in the ownership of the tooling team. labels Jun 15, 2026

l2ysho requested a review from DaveHanns June 15, 2026 22:13

add unit test

6322f2c

github-actions Bot added the tested Temporary label used only programatically for some analytics. label Jun 15, 2026

l2ysho marked this pull request as ready for review June 15, 2026 22:17

l2ysho requested a review from vladfrangu as a code owner June 15, 2026 22:17

l2ysho modified the milestones: 143rd sprint - Tooling team, 143rd sprint - DX team Jun 16, 2026

l2ysho added 2 commits June 22, 2026 09:38

Merge branch 'master' into 1136-improve-apify-push-final-status-and-j…

e3cb16f

…son-output-for-agents2

Merge branch 'master' into 1136-improve-apify-push-final-status-and-j…

b55a4e3

…son-output-for-agents2

DaveHanns reviewed Jun 22, 2026

View reviewed changes

DaveHanns reviewed Jun 23, 2026

View reviewed changes

Merge branch 'master' into 1136-improve-apify-push-final-status-and-j…

913b8ba

…son-output-for-agents2

DaveHanns reviewed Jun 23, 2026

View reviewed changes

DaveHanns requested changes Jun 23, 2026

View reviewed changes

Conversation

l2ysho commented Jun 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DaveHanns Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

DaveHanns left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

l2ysho commented Jun 15, 2026 •

edited

Loading

DaveHanns Jun 23, 2026 •

edited

Loading